home *** CD-ROM | disk | FTP | other *** search
/ Power Programmierung 2 / Power-Programmierung CD 2 (Tewi)(1994).iso / gnu / gnulib / sipp / install < prev    next >
Encoding:
Text File  |  1992-05-03  |  5.9 KB  |  148 lines
  1.            Installation of the SIPP Library
  2.            ================================
  3.  
  4.   This file describes the installation of the SIPP rendering library.
  5. You should install not only the library itself, but also the on-line
  6. documentation so that your users will know how to use it.  You can
  7. create typeset documentation from the file 'sipp.texinfo' as well as
  8. an on-line Info file.  The following steps are also described in the
  9. texinfo manual in the chapter 'Installation'.
  10.  
  11.  
  12. I. Installing the C library
  13.  
  14.   Edit the file 'Makefile' to reflect the situation at your site.  The
  15. things you might have to change are clearly marked in the beginning of
  16. that file.  They are also described below.
  17.  
  18.   * The 'NOVOID' definition should be used if the C compiler on your
  19.     system does not understand the type 'void'. 
  20.  
  21.   * If the C library on your system does not contain the functions
  22.     'memcpy()' or 'memset()', or the include file 'memory.h'does not 
  23.     exist, you should use the 'NOMEMCPY' definition.
  24.  
  25.   * If your system does not support the 'alloca()' function, the
  26.     'ALLOCA' definition should be used.  This will cause SIPP to use
  27.     the portable version of 'alloca()' available from the GNU project.
  28.  
  29.   * The definitions of 'LIBDIR', 'INCLUDEDIR', 'MANDIR' and 'MANEXT'
  30.     determines where in your file hierarchy SIPP will be installed.
  31.     'LIBDIR' is the directory where the final library file (libsipp.a)
  32.     will be placed.  When a program that uses SIPP is linked, this
  33.     directory should be in the path where the linker looks for
  34.     libraries, either direct or with the aid of the '-L' switch.
  35.     'INCLUDEDIR' is the directory where the includefiles necessary to
  36.     use SIPP will be placed.  When a program that uses SIPP is
  37.     compiled, this directory should be in the path where the compiler
  38.     searches for include files, either direct or with the aid of the
  39.     '-I' switch.  'MANDIR' is the directory in which to place the UNIX
  40.     style manual page provided with SIPP.  'MANEXT' determines what 
  41.     extension that manual file will get. 
  42.  
  43.  
  44.   Apart from these SIPP specific definitions, the usual C compiler and 
  45. flags to this compiler must of course be set to values suitable on your
  46. system.
  47.  
  48.   The only other item, apart from the Makefile, is a definition in the
  49. includefile 'sipp.h' in the 'libsipp' directory.  In this file a macro
  50. called 'RANDOM()' is defined.  If your system does not have the
  51. 'drand48()' function, you must change this definition.  The macro
  52. should return a random floating point number in the range (-1, 1).
  53.  
  54.   By just typing 'make' in the 'sipp-3.0' directory, the library and
  55. the demonstration programs will be compiled.  The library is not
  56. installed, but only compiled in place.
  57.  
  58.   By typing 'make library', the library will be compiled in place but
  59. the demonstration programs will not.
  60.  
  61.   Typing 'make demos' will compile the demonstration programs only.
  62. Since the demos require it, however, the library will also be compiled
  63. if it was not done before.
  64.  
  65.   Finally, typing 'make install' will compile the library if it was
  66. not done before, and copy that, the include files and the manual pages
  67. to their appropriate places.
  68.  
  69.  
  70. NOTE: When the library libsipp.a is created, the make process attempts to
  71. run the program "ranlib" on it. Some systems don't use this program and
  72. make will then complain but ignore the generated error. This is normal
  73. and you can safely ignore it too.
  74.  
  75.  
  76.  
  77. II. Installing the Info manual
  78.  
  79. 1. Create the Info files 'sipp', 'sipp-1', 'sipp-2' and so on from
  80.    'sipp.texinfo'.  If you have the 'makeinfo' program, you can do
  81.    this by running it on 'sipp.texinfo'.  Otherwise you can do it with
  82.    emacs by running these steps: 
  83.  
  84.   1.1  Read 'sipp.texinfo' into an emacs buffer.  
  85.  
  86.   1.2  Type `'M-X texinfo-format-buffer'' 
  87.  
  88.   1.3  Save the newly created Info file 'sipp', 'sipp-1', 'sipp-2' and 
  89.        so on.  
  90.  
  91. 2. Move the Info files 'sipp', 'sipp-1' and so on to the standard Info 
  92.    directory.  Usually this is '/usr/gnu/emacs/info' or something
  93.    similar. (See step 3 above).
  94.  
  95. 3. Edit the file 'dir' in the info directory and enter one line to
  96.    contain a pointer to the Info file 'sipp'.  The line can, for
  97.    instance, look like this: 
  98.  
  99.   * SIPP: (sipp).       3D rendering library.
  100.  
  101.  
  102. III. Creating typeset manual
  103.  
  104.   You can also make a typeset manual from the file 'sipp.texinfo'.  To
  105. do this, you must have the TeX text formatting program installed. However,
  106. we have put a ready made PostScript version of the manual in the doc
  107. directory too, for those of you who haven't got TeX, but have access to a
  108. PostScript printer.  
  109.  
  110.  
  111. The default setup is to format the manual for one-sided printing.  The
  112. supplied PostScript file is also formatted for one-sided printing.  If you
  113. want formatting for two sided printing you should change the line:
  114.  
  115. @setchapternewpage on
  116.  
  117. in the beginning of the file sipp.texinfo into:
  118.  
  119. @setchapternewpage odd
  120.  
  121. and then proceed as follows.
  122.  
  123.  
  124. To typeset the manual, just follow these steps:
  125.  
  126. 1. If the file 'texinfo.tex' is not properly installed in the path
  127.    given by the environment variable 'TEXINPUTS', get it and put
  128.    it in the same directory as 'sipp.texinfo' (the 'doc' directory of
  129.    SIPP).  This file contains macros used by the TeX text formatting
  130.    program to produce typeset output from a texinfo file.  You can get
  131.    this from, e.g., 'prep.ai.mit.edu' in the US or from 'isy.liu.se'
  132.    in Europe.  
  133.  
  134. 2. Run TeX by typing `'tex sipp.texinfo''.  You might need to do this
  135.    twice to get all cross references correct.  If you have the
  136.    'texindex' program, you can create a sorted index by typing
  137.  
  138.       texindex sipp.cp sipp.fn
  139.  
  140.    between the two TeX passes.  If you don't do this, you still get a
  141.    typeset manual, but you will not get a correct index. 
  142.  
  143. 3. Convert the resulting device independent file 'sipp.dvi' to a form
  144.    which your printer can output and print it.  If you have a
  145.    postscript printer there is a program, 'dvi2ps', which can do this.
  146.    There is also a program which comes together with TeX, 'dvips',
  147.    which you can use. 
  148.